Add a link to browse crate source on docs.rs #12550
Conversation
Turbo87
added
the
C-enhancement ✨
carols10cents
force-pushed
the
source-link
branch
2 times, most recently
from
c583304 to
bf6d458
Compare
Don't show the link if there aren't any docs.rs builds as clicking on the link won't work then, but do still show the source link even if a non-docs.rs documentation link has been specified to enable review of the source exactly as crates.io serves it.
carols10cents
force-pushed
the
source-link
branch
from
19002b9 to
339991b
Compare
|
@Turbo87 i quit. I can't figure out why the remaining one qunit and one e2e tests are failing; i added the mock docs.rs requests exactly like in the other tests that are passing, but the source link isn't showing up and I don't understand why. The source link is showing up in some of the percy screenshots as expected, but it also looks like the main baseline in percy has some 404 pages saved? I also can't get the frontend working locally proxying to the live crates.io; when I run the frontend everything looks fine: but when i visit localhost:4200/crates/rand for example, it shows the "Failed to load crate data" generic javascript error message (in both firefox and chrome). In firefox, there aren't any errors showing up in the web development tools console, but if i open tools -> browser tools -> browser console, i see: and in chrome i don't see any console errors: 
if I make this change in app/routes/crate.js: } catch (error) {
if (error instanceof NotFoundError) {
let title = `Crate "${crateName}" not found`;
this.router.replaceWith('catch-all', { transition, error, title });
} else {
console.log(error);
let title = `Failed to load crate data`;
this.router.replaceWith('catch-all', { transition, error, title, tryAgain: true });
}
}THEN i see: which... wtf????? what am i doing wrong????????? |
|
oh ffs nevermind... i did the good old "blow away node_modules" and now i can load a local page proxying to crates.io. |
|
ok yeah even with getting this running locally i still dont understand why this code isn't working. if i go to a crate like rand that doesn't have if i go to a crate like ripgrep that does have |
|
I'll take a look once I'm back at a computer :) |
|
I think what you're looking for is: crates.io/app/routes/crate/version.js Lines 61 to 68 in 8a05f6e the |
😢 |
Even if the crate has a documentation link specified, we want to show a link to the source view of docs.rs. But we still want to check that docs.rs has had a chance to build the crate's docs before we add the link to browse the source, so we do need to make this request.
|
Ok-- this looks like it's working the way i intended now, aside from the expected percy differences. Ready for rereview @Turbo87 , thank you for your help!! |
4 participants
Don't show the link if there aren't any docs.rs builds as clicking on the link won't work then, but do still show the source link even if a non-docs.rs documentation link has been specified to enable review of the source exactly as crates.io serves it.